* @accel_group: the accelerator group to query
* @accel_key: key value of the accelerator
* @accel_mods: modifier combination of the accelerator
- * @n_entries: (out) (allow-none): location to return the number
+ * @n_entries: (out) (optional): location to return the number
* of entries found, or %NULL
*
* Queries an accelerator group for all entries matching @accel_key
* and @accel_mods.
*
- * Returns: (transfer none) (array length=n_entries): an array of
+ * Returns: (nullable) (transfer none) (array length=n_entries): an array of
* @n_entries #GtkAccelGroupEntry elements, or %NULL. The array
* is owned by GTK+ and must not be freed.
*/
* Finds the #GtkAccelGroup to which @closure is connected;
* see gtk_accel_group_connect().
*
- * Returns: (transfer none): the #GtkAccelGroup to which @closure
+ * Returns: (nullable) (transfer none): the #GtkAccelGroup to which @closure
* is connected, or %NULL
*/
GtkAccelGroup*
* Fetches the widget monitored by this accelerator label. See
* gtk_accel_label_set_accel_widget().
*
- * Returns: (transfer none): the object monitored by the accelerator label, or %NULL.
+ * Returns: (nullable) (transfer none): the object monitored by the accelerator label, or %NULL.
**/
GtkWidget*
gtk_accel_label_get_accel_widget (GtkAccelLabel *accel_label)
* The returned widget does not have a reference added, so
* you do not need to unref it.
*
- * Returns: (transfer none): pointer to the #GtkWidget
+ * Returns: (nullable) (transfer none): pointer to the #GtkWidget
* corresponding to the #GtkAccessible, or %NULL.
*
* Since: 2.22
*
* See gtk_actionable_set_action_name() for more information.
*
- * Returns: the action name, or %NULL if none is set
+ * Returns: (nullable): the action name, or %NULL if none is set
*
* Since: 3.4
**/
gtk_actionable_set_action_target_value (actionable, NULL);
g_strfreev (parts);
}
+
*
* Returns the currently selected application.
*
- * Returns: (transfer full): a #GAppInfo for the currently selected
+ * Returns: (nullable) (transfer full): a #GAppInfo for the currently selected
* application, or %NULL if none is selected. Free with g_object_unref()
*
* Since: 3.0
*
* Returns the text to display at the top of the dialog.
*
- * Returns: the text to display at the top of the dialog,
+ * Returns: (nullable): the text to display at the top of the dialog,
* or %NULL, in which case a default text is displayed
*/
const gchar *
*
* Returns the text to display at the top of the dialog.
*
- * Returns: the text to display at the top of the dialog, or %NULL, in which
+ * Returns: (nullable): the text to display at the top of the dialog, or %NULL, in which
* case a default text is displayed
*/
const gchar *
*
* Returns the #GtkApplicationWindow with the given ID.
*
- * Returns: (transfer none): the window with ID @id, or
+ * Returns: (nullable) (transfer none): the window with ID @id, or
* %NULL if there is no window with this ID
*
* Since: 3.6
*
* Returns the child widget contained in page number @page_num.
*
- * Returns: (transfer none): the child widget, or %NULL
+ * Returns: (nullable) (transfer none): the child widget, or %NULL
* if @page_num is out of bounds
*
* Since: 2.10
* The @set_name can either be a name used for gtk_binding_set_new()
* or the type name of a class used in gtk_binding_set_by_class().
*
- * Returns: (transfer none): %NULL or the specified binding set
+ * Returns: (nullable) (transfer none): %NULL or the specified binding set
*/
GtkBindingSet*
gtk_binding_set_find (const gchar *set_name)
* Gets the object named @name. Note that this function does not
* increment the reference count of the returned object.
*
- * Returns: (transfer none): the object named @name or %NULL if
+ * Returns: (nullable) (transfer none): the object named @name or %NULL if
* it could not be found in the object tree.
*
* Since: 2.12
* or for any case that one might be cusomizing signal connections
* using gtk_builder_connect_signals_full()
*
- * Returns: The callback symbol in @builder for @callback_name, or %NULL
+ * Returns: (nullable): The callback symbol in @builder for @callback_name, or %NULL
*
* Since: 3.10
*/
* g_application_get_default(). If you want to use another application
* for constructing proxies, use gtk_builder_set_application().
*
- * Returns: (transfer none): the application being used by the builder,
+ * Returns: (nullable) (transfer none): the application being used by the builder,
* or %NULL
*
* Since: 3.10
* This may have been explicitly set by gtk_button_set_image()
* or constructed by gtk_button_new_from_stock().
*
- * Returns: (transfer none): a #GtkWidget or %NULL in case there is no image
+ * Returns: (nullable) (transfer none): a #GtkWidget or %NULL in case
+ * there is no image
*
* Since: 2.6
*/
*
* Since: 2.14
*
- * Returns: Newly allocated string with Pango markup with details
- * for the specified day, or %NULL.
+ * Returns: (nullable) (transfer full): Newly allocated string with Pango markup
+ * with details for the specified day or %NULL.
*/
typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,
guint year,
* then chose to activate the focus cell for which the event
* cell may have been a sibling.
*
- * Returns: (transfer none): the #GtkCellRenderer for which @renderer
+ * Returns: (nullable) (transfer none): the #GtkCellRenderer for which @renderer
* is a sibling, or %NULL.
*
* Since: 3.0
*
* Passes an activate event to the cell renderer for possible processing.
*
- * Returns: (transfer none): A new #GtkCellEditable, or %NULL
+ * Returns: (nullable) (transfer none): A new #GtkCellEditable, or %NULL
**/
GtkCellEditable *
gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
* Returns the model for @cell_view. If no model is used %NULL is
* returned.
*
- * Returns: (transfer none): a #GtkTreeModel used or %NULL
+ * Returns: (nullable) (transfer none): a #GtkTreeModel used or %NULL
*
* Since: 2.16
**/
* displayed row. If no row is currently displayed,
* %NULL is returned.
*
- * Returns: the currently displayed row or %NULL
+ * Returns: (nullable) (transfer full): the currently displayed row or %NULL
*
* Since: 2.6
*/
* gtk_clipboard_clear() has not subsequently called, returns the owner set
* by gtk_clipboard_set_with_owner().
*
- * Returns: (transfer none): the owner of the clipboard, if any;
+ * Returns: (nullable) (transfer none): the owner of the clipboard, if any;
* otherwise %NULL.
**/
GObject *
* currently focused widget. That can be obtained by calling
* gtk_window_get_focus().
*
- * Returns: (transfer none): The child widget which will receive the
+ * Returns: (nullable) (transfer none): The child widget which will receive the
* focus inside @container when the @conatiner is focussed,
* or %NULL if none is set.
*
* Retrieves the vertical focus adjustment for the container. See
* gtk_container_set_focus_vadjustment().
*
- * Returns: (transfer none): the vertical focus adjustment, or %NULL if
- * none has been set.
+ * Returns: (nullable) (transfer none): the vertical focus adjustment, or
+ * %NULL if none has been set.
**/
GtkAdjustment *
gtk_container_get_focus_vadjustment (GtkContainer *container)
* Retrieves the horizontal focus adjustment for the container. See
* gtk_container_set_focus_hadjustment ().
*
- * Returns: (transfer none): the horizontal focus adjustment, or %NULL if
+ * Returns: (nullable) (transfer none): the horizontal focus adjustment, or %NULL if
* none has been set.
**/
GtkAdjustment *
* Gets the widget button that uses the given response ID in the action area
* of a dialog.
*
- * Returns: (transfer none): the @widget button that uses the given
+ * Returns: (nullable) (transfer none): the @widget button that uses the given
* @response_id, or %NULL.
*
* Since: 2.20
*
* Determines the source widget for a drag.
*
- * Returns: (transfer none): if the drag is occurring
+ * Returns: (nullable) (transfer none): if the drag is occurring
* within a single application, a pointer to the source widget.
* Otherwise, %NULL.
*/
* Returns the list of targets this widget can accept from
* drag-and-drop.
*
- * Returns: (transfer none): the #GtkTargetList, or %NULL if none
+ * Returns: (nullable) (transfer none): the #GtkTargetList, or %NULL if none
*/
GtkTargetList*
gtk_drag_dest_get_target_list (GtkWidget *widget)
* Gets the list of targets this widget can provide for
* drag-and-drop.
*
- * Returns: (transfer none): the #GtkTargetList, or %NULL if none
+ * Returns: (nullable) (transfer none): the #GtkTargetList, or %NULL if none
*
* Since: 2.4
*/
* Returns the model the #GtkEntryCompletion is using as data source.
* Returns %NULL if the model is unset.
*
- * Returns: (transfer none): A #GtkTreeModel, or %NULL if none
+ * Returns: (nullable) (transfer none): A #GtkTreeModel, or %NULL if none
* is currently being used
*
* Since: 2.4
* Note that a text column must have been set for this function to work,
* see gtk_entry_completion_set_text_column() for details.
*
- * Returns: (transfer full): The common prefix all rows starting with @key
- * or %NULL if no row matches @key.
+ * Returns: (nullable) (transfer full): The common prefix all rows starting with
+ * @key or %NULL if no row matches @key.
*
* Since: 3.4
**/
* Retrieves the label widget for the frame. See
* gtk_expander_set_label_widget().
*
- * Returns: (transfer none): the label widget,
+ * Returns: (nullable) (transfer none): the label widget,
* or %NULL if there is none
*
* Since: 2.4
* If the file chooser is in folder mode, this function returns the selected
* folder.
*
- * Returns: (type filename): The currently selected filename, or %NULL
- * if no file is selected, or the selected file can't
+ * Returns: (nullable) (type filename): The currently selected filename,
+ * or %NULL if no file is selected, or the selected file can't
* be represented with a local filename. Free with g_free().
*
* Since: 2.4
* currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
* usual way to get the selection.
*
- * Returns: (type filename): the full path of the current folder,
- * or %NULL if the current path cannot be represented as a local
+ * Returns: (nullable) (type filename): the full path of the current
+ * folder, or %NULL if the current path cannot be represented as a local
* filename. Free with g_free(). This function will also return
* %NULL if the file chooser was unable to load the last folder that
* was requested from it; for example, as would be for calling
* If the file chooser is in folder mode, this function returns the selected
* folder.
*
- * Returns: The currently selected URI, or %NULL
- * if no file is selected. If gtk_file_chooser_set_local_only() is set to %TRUE
- * (the default) a local URI will be returned for any FUSE locations.
- * Free with g_free()
+ * Returns: (nullable) (transfer full): The currently selected URI, or %NULL
+ * if no file is selected. If gtk_file_chooser_set_local_only() is set to
+ * %TRUE (the default) a local URI will be returned for any FUSE locations.
+ * Free with g_free()
*
* Since: 2.4
**/
* currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
* usual way to get the selection.
*
- * Returns: the URI for the current folder. Free with g_free(). This
- * function will also return %NULL if the file chooser was unable to load the
- * last folder that was requested from it; for example, as would be for calling
- * gtk_file_chooser_set_current_folder_uri() on a nonexistent folder.
+ * Returns: (nullable) (transfer full): the URI for the current folder.
+ * Free with g_free(). This function will also return %NULL if the file chooser
+ * was unable to load the last folder that was requested from it; for example,
+ * as would be for calling gtk_file_chooser_set_current_folder_uri() on a
+ * nonexistent folder.
*
* Since: 2.4
*/
* Gets the current preview widget; see
* gtk_file_chooser_set_preview_widget().
*
- * Returns: (transfer none): the current preview widget, or %NULL
+ * Returns: (nullable) (transfer none): the current preview widget, or %NULL
*
* Since: 2.4
**/
* Gets the #GFile that should be previewed in a custom preview
* Internal function, see gtk_file_chooser_get_preview_uri().
*
- * Returns: (transfer full): the #GFile for the file to preview,
+ * Returns: (nullable) (transfer full): the #GFile for the file to preview,
* or %NULL if no file is selected. Free with g_object_unref().
*
* Since: 2.14
* Gets the filename that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget().
*
- * Returns: (type filename): the filename to preview, or %NULL if
+ * Returns: (nullable) (type filename): the filename to preview, or %NULL if
* no file is selected, or if the selected file cannot be represented
* as a local filename. Free with g_free()
*
* Gets the URI that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget().
*
- * Returns: the URI for the file to preview, or %NULL if no file is
- * selected. Free with g_free().
+ * Returns: (nullable) (transfer full): the URI for the file to preview,
+ * or %NULL if no file is selected. Free with g_free().
*
* Since: 2.4
**/
* Gets the current preview widget; see
* gtk_file_chooser_set_extra_widget().
*
- * Returns: (transfer none): the current extra widget, or %NULL
+ * Returns: (nullable) (transfer none): the current extra widget, or %NULL
*
* Since: 2.4
**/
*
* Gets the current filter; see gtk_file_chooser_set_filter().
*
- * Returns: (transfer none): the current filter, or %NULL
+ * Returns: (nullable) (transfer none): the current filter, or %NULL
*
* Since: 2.4
**/
*
* Retrieves the custom label text for the accept button.
*
- * Returns: The custom label, or %NULL for the default. This string is
- * owned by GTK+ and should not be modified or freed
+ * Returns: (nullable): The custom label, or %NULL for the default. This string
+ * is owned by GTK+ and should not be modified or freed
*
* Since: 3.20
**/
*
* Retrieves the custom label text for the cancel button.
*
- * Returns: The custom label, or %NULL for the default. This string is
- * owned by GTK+ and should not be modified or freed
+ * Returns: (nullable): The custom label, or %NULL for the default. This string
+ * is owned by GTK+ and should not be modified or freed
*
* Since: 3.20
**/
*
* Gets the human-readable name for the filter. See gtk_file_filter_set_name().
*
- * Returns: The human-readable name of the filter,
+ * Returns: (nullable): The human-readable name of the filter,
* or %NULL. This value is owned by GTK+ and must not
* be modified or freed.
*
*
* If the selected font is not installed, returns %NULL.
*
- * Returns: (transfer none): A #PangoFontFamily representing the
+ * Returns: (nullable) (transfer none): A #PangoFontFamily representing the
* selected font family, or %NULL. The returned object is owned by @fontchooser
* and must not be modified or freed.
*
*
* If the selected font is not installed, returns %NULL.
*
- * Returns: (transfer none): A #PangoFontFace representing the
+ * Returns: (nullable) (transfer none): A #PangoFontFace representing the
* selected font group details, or %NULL. The returned object is owned by
* @fontchooser and must not be modified or freed.
*
* Use pango_font_description_equal() if you want to compare two
* font descriptions.
*
- * Returns: (transfer full) (allow-none): A string with the name
+ * Returns: (nullable) (transfer full): A string with the name
* of the current font, or %NULL if no font is selected. You must
* free this string with g_free().
*
* Use pango_font_description_equal() if you want to compare two
* font descriptions.
*
- * Returns: (transfer full) (allow-none): A #PangoFontDescription for the
+ * Returns: (nullable) (transfer full): A #PangoFontDescription for the
* current font, or %NULL if no font is selected.
*
* Since: 3.2
* Gets the custom font map of this font chooser widget,
* or %NULL if it does not have one.
*
- * Returns: (transfer full) (allow-none): a #PangoFontMap, or %NULL
+ * Returns: (nullable) (transfer full): a #PangoFontMap, or %NULL
*
* Since: 3.18
*/
* for the label widget if a non-%NULL argument was passed
* to gtk_frame_new().)
*
- * Returns: the text in the label, or %NULL if there
+ * Returns: (nullable): the text in the label, or %NULL if there
* was no label widget or the lable widget was not
* a #GtkLabel. This string is owned by GTK+ and
* must not be modified or freed.
* Returns the master #GdkDevice that is currently operating
* on @gesture, or %NULL if the gesture is not being interacted.
*
- * Returns: (transfer none) (allow-none): a #GdkDevice, or %NULL
+ * Returns: (nullable) (transfer none): a #GdkDevice, or %NULL
*
* Since: 3.14
**/
* handled by @gesture. See gtk_gesture_set_window() for more
* information.
*
- * Returns: (transfer none) (allow-none): the user defined window, or %NULL if none
+ * Returns: (nullable) (transfer none): the user defined window, or %NULL if none
*
* Since: 3.14
**/
*
* Gets the current error set on the @area.
*
- * Returns: (transfer none): the #GError or %NULL
+ * Returns: (nullable) (transfer none): the #GError or %NULL
*
* Since: 3.16
*/
*
* Retrieves the title of the header. See gtk_header_bar_set_title().
*
- * Returns: the title of the header, or %NULL if none has
+ * Returns: (nullable): the title of the header, or %NULL if none has
* been set explicitly. The returned string is owned by the widget
* and must not be modified or freed.
*
*
* Retrieves the subtitle of the header. See gtk_header_bar_set_subtitle().
*
- * Returns: the subtitle of the header, or %NULL if none has
+ * Returns: (nullable): the subtitle of the header, or %NULL if none has
* been set explicitly. The returned string is owned by the widget
* and must not be modified or freed.
*
* Retrieves the custom title widget of the header. See
* gtk_header_bar_set_custom_title().
*
- * Returns: (transfer none): the custom title widget
+ * Returns: (nullable) (transfer none): the custom title widget
* of the header, or %NULL if none has been set explicitly.
*
* Since: 3.10
* filename if a builtin icon is returned; in this case, you should
* use gtk_icon_info_get_builtin_pixbuf().
*
- * Returns: (type filename): the filename for the icon, or %NULL
+ * Returns: (nullable) (type filename): the filename for the icon, or %NULL
* if gtk_icon_info_get_builtin_pixbuf() should be used instead.
* The return value is owned by GTK+ and should not be modified
* or freed.
* See gtk_icon_view_convert_widget_to_bin_window_coords() for converting
* widget coordinates to bin_window coordinates.
*
- * Returns: The #GtkTreePath corresponding to the icon or %NULL
- * if no icon exists at that position.
+ * Returns: (nullable) (transfer full): The #GtkTreePath corresponding
+ * to the icon or %NULL if no icon exists at that position.
*
* Since: 2.6
**/
* Returns the model the #GtkIconView is based on. Returns %NULL if the
* model is unset.
*
- * Returns: (transfer none): A #GtkTreeModel, or %NULL if none is
+ * Returns: (nullable) (transfer none): A #GtkTreeModel, or %NULL if none is
* currently being used.
*
* Since: 2.6
* The caller of this function does not own a reference to the
* returned pixbuf.
*
- * Returns: (transfer none): the displayed pixbuf, or %NULL if
+ * Returns: (nullable) (transfer none): the displayed pixbuf, or %NULL if
* the image is empty
**/
GdkPixbuf*
* The caller of this function does not own a reference to the
* returned animation.
*
- * Returns: (transfer none): the displayed animation, or %NULL if
+ * Returns: (nullable) (transfer none): the displayed animation, or %NULL if
* the image is empty
**/
GdkPixbufAnimation*
* Retrieves the target of the mnemonic (keyboard shortcut) of this
* label. See gtk_label_set_mnemonic_widget().
*
- * Returns: (transfer none): the target of the label’s mnemonic,
+ * Returns: (nullable) (transfer none): the target of the label’s mnemonic,
* or %NULL if none has been set and the default algorithm will be used.
**/
GtkWidget *
* effective attributes for the label, use
* pango_layout_get_attribute (gtk_label_get_layout (label)).
*
- * Returns: (transfer none): the attribute list, or %NULL
+ * Returns: (nullable) (transfer none): the attribute list, or %NULL
* if none was set.
**/
PangoAttrList *
* old version of gtk_check_version(), but still get loaded
* into an application using a newer version of GTK+.
*
- * Returns: %NULL if the GTK+ library is compatible with the
+ * Returns: (nullable): %NULL if the GTK+ library is compatible with the
* given version, or a string describing the version mismatch.
* The returned string is owned by GTK+ and should not be modified
* or freed.
* If the button does not use a #GtkMenu, this function
* returns %NULL.
*
- * Returns: (transfer none): a #GtkMenu or %NULL
+ * Returns: (nullable) (transfer none): a #GtkMenu or %NULL
*
* Since: 3.6
*/
*
* Returns the #GMenuModel used to generate the popup.
*
- * Returns: (transfer none): a #GMenuModel or %NULL
+ * Returns: (nullable) (transfer none): a #GMenuModel or %NULL
*
* Since: 3.6
*/
*
* Returns the parent #GtkWidget to use to line up with menu.
*
- * Returns: (transfer none): a #GtkWidget value or %NULL
+ * Returns: (nullable) (transfer none): a #GtkWidget value or %NULL
*
* Since: 3.6
*/
* If the button is not using a #GtkPopover, this function
* returns %NULL.
*
- * Returns: (transfer none): a #GtkPopover or %NULL
+ * Returns: (nullable) (transfer none): a #GtkPopover or %NULL
*
* Since: 3.12
*/
* Gets the submenu underneath this menu item, if any.
* See gtk_menu_item_set_submenu().
*
- * Returns: (transfer none): submenu for this menu item, or %NULL if none
+ * Returns: (nullable) (transfer none): submenu for this menu item, or %NULL if none
*/
GtkWidget *
gtk_menu_item_get_submenu (GtkMenuItem *menu_item)
*
* See gtk_menu_item_set_accel_path() for details.
*
- * Returns: the accelerator path corresponding to this menu
- * item’s functionality, or %NULL if not set
+ * Returns: (nullable) (transfer none): the accelerator path corresponding to
+ * this menu item’s functionality, or %NULL if not set
*
* Since: 2.14
*/
*
* Gets the title of the #GtkNativeDialog.
*
- * Returns: the title of the dialog, or %NULL if none has
+ * Returns: (nullable): the title of the dialog, or %NULL if none has
* been set explicitly. The returned string is owned by the widget
* and must not be modified or freed.
*
* Fetches the transient parent for this window. See
* gtk_native_dialog_set_transient_for().
*
- * Returns: (transfer none): the transient parent for this window, or %NULL
- * if no transient parent has been set.
+ * Returns: (nullable) (transfer none): the transient parent for this window,
+ * or %NULL if no transient parent has been set.
*
* Since: 3.20
**/
*
* Returns the child widget contained in page number @page_num.
*
- * Returns: (transfer none): the child widget, or %NULL
- * if @page_num is out of bounds
+ * Returns: (nullable) (transfer none): the child widget, or %NULL if @page_num
+ * is out of bounds
*/
GtkWidget*
gtk_notebook_get_nth_page (GtkNotebook *notebook,
* Retrieves the text of the tab label for the page containing
* @child.
*
- * Returns: the text of the tab label, or %NULL if the
- * tab label widget is not a #GtkLabel. The string is owned
- * by the widget and must not be freed.
+ * Returns: (nullable): the text of the tab label, or %NULL if the tab label
+ * widget is not a #GtkLabel. The string is owned by the widget and must not be
+ * freed.
*/
const gchar *
gtk_notebook_get_tab_label_text (GtkNotebook *notebook,
*
* Retrieves the menu label widget of the page containing @child.
*
- * Returns: (transfer none): the menu label, or %NULL if the
- * notebook page does not have a menu label other than the
- * default (the tab label).
+ * Returns: (nullable) (transfer none): the menu label, or %NULL if the
+ * notebook page does not have a menu label other than the default (the tab
+ * label).
*/
GtkWidget*
gtk_notebook_get_menu_label (GtkNotebook *notebook,
* Retrieves the text of the menu label for the page containing
* @child.
*
- * Returns: the text of the tab label, or %NULL if the
- * widget does not have a menu label other than the default
- * menu label, or the menu label widget is not a #GtkLabel.
- * The string is owned by the widget and must not be freed.
+ * Returns: (nullable): the text of the tab label, or %NULL if the widget does
+ * not have a menu label other than the default menu label, or the menu label
+ * widget is not a #GtkLabel. The string is owned by the widget and must not be
+ * freed.
*/
const gchar *
gtk_notebook_get_menu_label_text (GtkNotebook *notebook,
*
* Gets the current group name for @notebook.
*
- * Returns: (transfer none): the group name,
- * or %NULL if none is set.
+ * Returns: (nullable) (transfer none): the group name, or %NULL if none is set
*
* Since: 2.24
*/
*
* Gets one of the action widgets. See gtk_notebook_set_action_widget().
*
- * Returns: (transfer none): The action widget with the given @pack_type
- * or %NULL when this action widget has not been set
+ * Returns: (nullable) (transfer none): The action widget with the given
+ * @pack_type or %NULL when this action widget has not been set
*
* Since: 2.20
*/
* a #cairo_surface_t. If you need to keep this around over window
* resizes then you should add a reference to it.
*
- * Returns: (transfer none): A #cairo_surface_t pointer to the offscreen
+ * Returns: (nullable) (transfer none): A #cairo_surface_t pointer to the offscreen
* surface, or %NULL.
*
* Since: 2.20
* and the application should unreference it once it is no longer
* needed.
*
- * Returns: (transfer full): A #GdkPixbuf pointer, or %NULL.
+ * Returns: (nullable) (transfer full): A #GdkPixbuf pointer, or %NULL.
*
* Since: 2.20
*/
*
* Obtains the first child of the paned widget.
*
- * Returns: (transfer none): first child, or %NULL if it is not set.
+ * Returns: (nullable) (transfer none): first child, or %NULL if it is not set.
*
* Since: 2.4
**/
*
* Obtains the second child of the paned widget.
*
- * Returns: (transfer none): second child, or %NULL if it is not set.
+ * Returns: (nullable) (transfer none): second child, or %NULL if it is not set.
*
* Since: 2.4
**/
* function to get the location that is being referred to during the callbacks
* for your menu items.
*
- * Returns: (transfer full): a GFile with the selected location, or #NULL if nothing is visually
- * selected.
+ * Returns: (nullable) (transfer full): a GFile with the selected location, or
+ * %NULL if nothing is visually selected.
*
* Since: 3.10
*/
* and returns one of them. This function is used by #GtkFileChooser to implement
* the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark.
*
- * Returns: (transfer full): The bookmark specified by the index @n, or
- * #NULL if no such index exist. Note that the indices start at 0, even though
- * the file chooser starts them with the keyboard shortcut “Alt-1”.
+ * Returns: (nullable) (transfer full): The bookmark specified by the index @n, or
+ * %NULL if no such index exist. Note that the indices start at 0, even though
+ * the file chooser starts them with the keyboard shortcut "Alt-1".
*
* Since: 3.10
*/
*
* Retrieves the socket the plug is embedded in.
*
- * Returns: (transfer none): the window of the socket, or %NULL
+ * Returns: (nullable) (transfer none): the window of the socket, or %NULL
*
* Since: 2.14
**/
* Gets the widget that should be set as the default while
* the popover is shown.
*
- * Returns: (transfer none): the default widget, or %NULL if there is none
+ * Returns: (nullable) (transfer none): the default widget,
+ * or %NULL if there is none
*
* Since: 3.18
*/
* to the text, not a copy of it, so will become invalid
* if you change the text in the progress bar.
*
- * Returns: text, or %NULL; this string is owned by the widget
+ * Returns: (nullable): text, or %NULL; this string is owned by the widget
* and should not be modified or freed.
*/
const gchar*
* Gets the human-readable name for the filter.
* See gtk_recent_filter_set_name().
*
- * Returns: the name of the filter, or %NULL. The returned string
+ * Returns: (nullable): the name of the filter, or %NULL. The returned string
* is owned by the filter object and should not be freed.
*
* Since: 2.10
* returns a #GtkRecentInfo-struct containing informations about the resource
* like its MIME type, or its display name.
*
- * Returns: a #GtkRecentInfo-struct containing information
+ * Returns: (nullable): a #GtkRecentInfo-struct containing information
* about the resource pointed by @uri, or %NULL if the URI was
* not registered in the recently used resources list. Free with
* gtk_recent_info_unref().
* Gets the #GtkSettings object for the default GDK screen, creating
* it if necessary. See gtk_settings_get_for_screen().
*
- * Returns: (transfer none): a #GtkSettings object. If there is no default
- * screen, then returns %NULL.
+ * Returns: (nullable) (transfer none): a #GtkSettings object. If there is
+ * no default screen, then returns %NULL.
**/
GtkSettings*
gtk_settings_get_default (void)
* Retrieves the window of the plug. Use this to check if the plug has
* been created inside of the socket.
*
- * Returns: (transfer none): the window of the plug if available, or %NULL
+ * Returns: (nullable) (transfer none): the window of the plug if
+ * available, or %NULL
*
* Since: 2.14
**/
* Retrieves the stack.
* See gtk_stack_sidebar_set_stack().
*
- * Returns: (transfer full): the associated #GtkStack or
+ * Returns: (nullable) (transfer full): the associated #GtkStack or
* %NULL if none has been set explicitly
*
* Since: 3.16
* Retrieves the stack.
* See gtk_stack_switcher_set_stack().
*
- * Returns: (transfer none): the stack, or %NULL if
+ * Returns: (nullable) (transfer none): the stack, or %NULL if
* none has been set explicitly.
*
* Since: 3.10
* Shorthand CSS properties cannot be queried for a location and will
* always return %NULL.
*
- * Returns: %NULL or the section where value was defined
+ * Returns: (nullable) (transfer none): %NULL or the section where a value
+ * for @property was defined
**/
GtkCssSection *
gtk_style_context_get_section (GtkStyleContext *context,
* Gets the parent context set via gtk_style_context_set_parent().
* See that function for details.
*
- * Returns: (transfer none): the parent context or %NULL
+ * Returns: (nullable) (transfer none): the parent context or %NULL
*
* Since: 3.4
**/
*
* Returns the #GdkFrameClock to which @context is attached.
*
- * Returns: (transfer none): a #GdkFrameClock, or %NULL
+ * Returns: (nullable) (transfer none): a #GdkFrameClock, or %NULL
* if @context does not have an attached frame clock.
*
* Since: 3.8
* gtk_test_widget_click() for possible caveats involving the search of
* such widgets and synthesizing widget events.
*
- * Returns: (transfer none): a valid widget if any is found or %NULL.
+ * Returns: (nullable) (transfer none): a valid widget if any is found or %NULL.
*
* Since: 2.14
**/
* Returns the mark named @name in buffer @buffer, or %NULL if no such
* mark exists in the buffer.
*
- * Returns: (transfer none): a #GtkTextMark, or %NULL
+ * Returns: (nullable) (transfer none): a #GtkTextMark, or %NULL
**/
GtkTextMark*
gtk_text_buffer_get_mark (GtkTextBuffer *buffer,
* A function that is called to serialize the content of a text buffer.
* It must return the serialized form of the content.
*
- * Returns: a newly-allocated array of guint8 which contains the serialized
- * data, or %NULL if an error occurred
+ * Returns: (nullable): a newly-allocated array of guint8 which contains
+ * the serialized data, or %NULL if an error occurred
*/
typedef guint8 * (* GtkTextBufferSerializeFunc) (GtkTextBuffer *register_buffer,
GtkTextBuffer *content_buffer,
*
* Look up a named tag.
*
- * Returns: (transfer none): The tag, or %NULL if none by that name is in the table.
+ * Returns: (nullable) (transfer none): The tag, or %NULL if none by that
+ * name is in the table.
**/
GtkTextTag*
gtk_text_tag_table_lookup (GtkTextTagTable *table,
* “standard” (8-space) tabs are used. Free the return value
* with pango_tab_array_free().
*
- * Returns: copy of default tab array, or %NULL if “standard”
- * tabs are used; must be freed with pango_tab_array_free().
+ * Returns: (nullable) (transfer full): copy of default tab array, or %NULL if
+ * “standard" tabs are used; must be freed with pango_tab_array_free().
**/
PangoTabArray*
gtk_text_view_get_tabs (GtkTextView *text_view)
* height is 0, and are nonexistent before the widget has been
* realized.
*
- * Returns: (transfer none): a #GdkWindow, or %NULL
+ * Returns: (nullable) (transfer none): a #GdkWindow, or %NULL
**/
GdkWindow*
gtk_text_view_get_window (GtkTextView *text_view,
* Returns the @n'th item on @toolbar, or %NULL if the
* toolbar does not contain an @n'th item.
*
- * Returns: (transfer none): The @n'th #GtkToolItem on @toolbar,
+ * Returns: (nullable) (transfer none): The @n'th #GtkToolItem on @toolbar,
* or %NULL if there isn’t an @n'th item.
*
* Since: 2.4
* doesn’t have a label. or uses a the label from a stock item. The returned
* string is owned by GTK+, and must not be modified or freed.
*
- * Returns: The label, or %NULL
+ * Returns: (nullable): The label, or %NULL
*
* Since: 2.4
**/
* Returns the name of the themed icon for the tool button,
* see gtk_tool_button_set_icon_name().
*
- * Returns: the icon name or %NULL if the tool button has
+ * Returns: (nullable): the icon name or %NULL if the tool button has
* no themed icon
*
* Since: 2.8
* Returns the widget used as label on @button.
* See gtk_tool_button_set_label_widget().
*
- * Returns: (transfer none): The widget used as label
+ * Returns: (nullable) (transfer none): The widget used as label
* on @button, or %NULL.
*
* Since: 2.4
* Return the widget used as icon widget on @button.
* See gtk_tool_button_set_icon_widget().
*
- * Returns: (transfer none): The widget used as icon
+ * Returns: (nullable) (transfer none): The widget used as icon
* on @button, or %NULL.
*
* Since: 2.4
* Gets the item at position (x, y).
* See gtk_tool_palette_get_drop_group().
*
- * Returns: (transfer none): the #GtkToolItem at position or %NULL if there is no such item
+ * Returns: (nullable) (transfer none): the #GtkToolItem at position or %NULL if there is no such item
*
* Since: 2.20
*/
*
* Gets the group at position (x, y).
*
- * Returns: (transfer none): the #GtkToolItemGroup at position or %NULL
- * if there is no such group
+ * Returns: (nullable) (transfer none): the #GtkToolItemGroup at position
+ * or %NULL if there is no such group
*
* Since: 2.20
*/
* child model or points to a row which is not visible in @filter, then %NULL
* is returned.
*
- * Returns: A newly allocated #GtkTreePath, or %NULL.
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL.
*
* Since: 2.4
*/
* point to the same location in the model not being filtered. If @filter_path
* does not point to a location in the child model, %NULL is returned.
*
- * Returns: A newly allocated #GtkTreePath, or %NULL.
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL.
*
* Since: 2.4
*/
* point to the same row in the sorted model. If @child_path isn’t a valid
* path on the child model, then %NULL is returned.
*
- * Returns: A newly allocated #GtkTreePath, or %NULL
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL
**/
GtkTreePath *
gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
* sorted. If @sorted_path does not point to a location in the child model,
* %NULL is returned.
*
- * Returns: A newly allocated #GtkTreePath, or %NULL
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL
**/
GtkTreePath *
gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
*
* Gets the #GtkTreeViewColumn at the given position in the #tree_view.
*
- * Returns: (transfer none): The #GtkTreeViewColumn, or %NULL if the
- * position is outside the range of columns.
+ * Returns: (nullable) (transfer none): The #GtkTreeViewColumn, or %NULL if the
+ * position is outside the range of columns.
**/
GtkTreeViewColumn *
gtk_tree_view_get_column (GtkTreeView *tree_view,
* This is used primarily to compare to `event->window`
* to confirm that the event on @tree_view is on the right window.
*
- * Returns: (transfer none): A #GdkWindow, or %NULL when @tree_view
- * hasn’t been realized yet
+ * Returns: (nullable) (transfer none): A #GdkWindow, or %NULL when @tree_view
+ * hasn’t been realized yet.
**/
GdkWindow *
gtk_tree_view_get_bin_window (GtkTreeView *tree_view)
* Returns the #GtkWidget in the button on the column header.
* If a custom widget has not been set then %NULL is returned.
*
- * Returns: (transfer none): The #GtkWidget in the column
+ * Returns: (nullable) (transfer none): The #GtkWidget in the column
* header, or %NULL
**/
GtkWidget *
* If @column is currently not inserted in any tree view, %NULL is
* returned.
*
- * Returns: (transfer none): The tree view wherein @column has
+ * Returns: (nullable) (transfer none): The tree view wherein @column has
* been inserted if any, %NULL otherwise.
*
* Since: 2.12
*
* Unrealized widgets do not have a frame clock.
*
- * Returns: (transfer none): a #GdkFrameClock (or #NULL if widget is unrealized)
+ * Returns: (nullable) (transfer none): a #GdkFrameClock,
+ * or #NULL if widget is unrealized
*
* Since: 3.8
*/
*
* Returns the current grab widget for @device, or %NULL if none.
*
- * Returns: (transfer none): The grab widget, or %NULL
+ * Returns: (nullable) (transfer none): The grab widget, or %NULL
*
* Since: 3.0
*/
projects / gtk4.git / commitdiff